/* ===================

AX2E (AXESCON XACML 2.0 Engine) is the Java authorization engine, which implements OASIS XACML 2.0 standard.
Copyright (C) 2007 AXESCON LLC

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA


Contact: AXESCON LLC - info{at}axescon.com

 =================== */
package axescon.xacml.model.ctx;


/**
 * @author argyn
 * An XML Request(@urn:oasis:names:tc:xacml:2.0:context:schema:os).
 * <p/>
 * Responsibilities: represents XACML Context Request element
 */
public interface Request extends axescon.xacml.model.ModelObject {

    /**
     * Gets a List of "Subject" elements
     */
    Subject[] getSubjectArray();

    /**
     * Gets a List of "Subject" elements
     */
    void setSubjectArray(Subject[] sl);

    /**
     * Gets a List of "Resource" elements
     */
    Resource[] getResourceArray();

    void setResourceArray(Resource[] rl);

    /**
     * Gets the "Action" element
     */
    RequestPart getAction();

    /**
     * Sets the "Action" element
     */
    void setAction(RequestPart action);

    /**
     * Gets the "Environment" element
     */
    RequestPart getEnvironment();

    /**
     * Sets the "Environment" element
     */
    void setEnvironment(RequestPart environment);

    /**
     * this returns low level implementation of XACML Request. For instance, if the concrete
     * engine implementation has internal representation of XACML Request, it can be
     * set to this field for future use by the engine. Although, this field is part of
     * AXESCON XACML API , it's not intended for use by client code. It's for solely
     * internal usage by the Engine.
     *
     * @return low level implementation of XACML Request
     */
    Object getLLObject();
}
